Vcenter Vm Hardware Serial CreateSpec

Vcenter Vm Hardware Serial CreateSpec
Vcenter Vm Hardware Serial CreateSpec

The Vcenter Vm Hardware Serial CreateSpec schema provides a specification for the configuration of a newly-created virtual serial port.

JSON Example
{
    "yield_on_poll": false,
    "backing": {
        "type": "string",
        "file": "string",
        "host_device": "string",
        "pipe": "string",
        "no_rx_loss": false,
        "network_location": "string",
        "proxy": "string"
    },
    "start_connected": false,
    "allow_guest_control": false
}
boolean
yield_on_poll
Optional

CPU yield behavior. If set to true, the virtual machine will periodically relinquish the processor if its sole task is polling the virtual serial port. The amount of time it takes to regain the processor will depend on the degree of other virtual machine activity on the host.

If missing or null, defaults to false.

backing
Optional

Physical resource backing for the virtual serial port.

If missing or null, defaults to automatic detection of a suitable host device.

boolean
start_connected
Optional

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

Defaults to false if missing or null.

boolean
allow_guest_control
Optional

Flag indicating whether the guest can connect and disconnect the device.

Defaults to false if missing or null.